Pocketbase Kotlin/io.github.agrevster.pocketbaseKotlin.dsl.query

Package-level declarations

Types

@Serializable

Used for when you wish to serialize a Record with multiple expanded relations of different types or nested relations. Be sure you include the ExpandRelations field in the request.

ExpandRecord

@Serializable

open class ExpandRecord<T : Record> : Record

Used for when you wish to serialize a Record with expanded relations. Type T is the Serializable class of the related record. Be sure you include the ExpandRelations field in the request.

ExpandRecordList

@Serializable

open class ExpandRecordList<T : Record> : Record

Used for when you wish to serialize a list of Record with expanded relations. Type T is the Serializable class of the related record in the list. Be sure you include the ExpandRelations field in the request.

ExpandRelations

data class ExpandRelations(val relations: String? = null)

This allows a Record's relations to be expanded and added to the response.

Filter

data class Filter(val expression: String? = null)

Used to filter the list of Records returned by a request. See the Pocketbase docs for a guide on how to format a filter request.

ShowFields

class ShowFields(fields: String)

This specifies which fields in a Record are shown in the request's response See this example for an explanation on how to use ShowFields

SortFields

data class SortFields(val fields: String)

An idiomatic way to handle Pocketbase sorting. Add + before your SortFields object to sort with the records you included on top, or add - if you want those items to come last.